fix(custom-element): prevent injecting child styles if shadowRoot is false #12769

edison1105 · 2025-01-22T12:48:49Z

Summary by CodeRabbit

Bug Fixes
- Ensured that styles are not injected into the shadow root of custom elements when the shadow DOM is explicitly disabled.
Tests
- Added a test to verify that child component styles are not injected when a custom element is created with shadow DOM disabled.

…false

github-actions · 2025-01-22T12:49:53Z

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	101 kB (+27 B)	38.3 kB (+10 B)	34.5 kB (+29 B)
vue.global.prod.js	159 kB (+27 B)	58.5 kB (+11 B)	52.1 kB (+76 B)

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.6 kB (+27 B)	18.2 kB (+17 B)	16.7 kB (+14 B)
createApp	54.6 kB (+27 B)	21.2 kB (+17 B)	19.4 kB (+19 B)
createSSRApp	58.8 kB (+27 B)	23 kB (+14 B)	21 kB (+29 B)
defineCustomElement	59.5 kB (+27 B)	22.8 kB (+10 B)	20.8 kB (+6 B)
overall	68.7 kB (+27 B)	26.4 kB (+19 B)	24.1 kB (+11 B)

pkg-pr-new · 2025-01-22T12:50:29Z

Open in StackBlitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@12769

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@12769

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@12769

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@12769

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@12769

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@12769

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@12769

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@12769

@vue/shared

npm i https://pkg.pr.new/@vue/shared@12769

vue

npm i https://pkg.pr.new/vue@12769

@vue/compat

npm i https://pkg.pr.new/@vue/compat@12769

commit: 86301f1

coderabbitai · 2025-05-26T01:19:20Z

"""

Walkthrough

The change updates the custom element style injection logic in the renderer to check if the shadowRoot property is explicitly set to false before injecting child component styles. Additionally, a new test verifies that no style injection occurs when shadowRoot is disabled via the custom element API.

Changes

File(s)	Change Summary
packages/runtime-core/src/renderer.ts	Added a conditional check for `shadowRoot: false` before injecting child styles into custom elements.
packages/runtime-dom/tests/customElement.spec.ts	Added a test to ensure styles are not injected when `shadowRoot` is set to false in custom elements.

Sequence Diagram(s)

sequenceDiagram
    participant App as App
    participant Renderer as Renderer
    participant CustomElement as CustomElement (VueElement)
    participant ShadowRoot as ShadowRoot

    App->>Renderer: Mount custom element
    Renderer->>CustomElement: Check shadowRoot property
    alt shadowRoot !== false
        Renderer->>CustomElement: Call _injectChildStyle(type)
        CustomElement->>ShadowRoot: Inject styles
    else shadowRoot === false
        Renderer-->>CustomElement: Skip style injection
    end

Assessment against linked issues

Objective	Addressed	Explanation
Prevent _injectChildStyle from running when shadowRoot is disabled in CustomElementApi (#12630)	✅
Ensure no errors occur and no style injection happens when shadowRoot is false (#12630)	✅

Possibly related PRs

fix(custom-element): ensure proper remount and prevent redundant slot parsing with shadowRoot false #13201: Addresses custom element remounting and slot parsing when shadowRoot is false, related to custom element behavior with shadowRoot disabled.

Poem

A bunny hopped through Vue’s bright core,
To fix a style bug—no errors anymore!
When shadowRoot is false, no styles sneak in,
The tests now pass, let the fun begin!
With gentle paws and code so neat,
This patch makes Vue’s custom elements sweet.
🐇✨
"""

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f608b23 and 86301f1.

📒 Files selected for processing (1)

packages/runtime-core/src/renderer.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/runtime-core/src/renderer.ts

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: upload
GitHub Check: autofix
GitHub Check: continuous-release

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

fix(custom-element): prevent injecting child styles if shadowRoot is …

585eabe

…false

test: add test case

3684d65

edison1105 added ready to merge The PR is ready to be merged. 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. scope: custom elements labels Jan 22, 2025

edison1105 added 2 commits February 10, 2025 14:11

chore: update

26698aa

Merge branch 'main' into edison/fix/12630

f608b23

chore: update

86301f1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(custom-element): prevent injecting child styles if shadowRoot is false #12769

fix(custom-element): prevent injecting child styles if shadowRoot is false #12769

Uh oh!

edison1105 commented Jan 22, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Jan 22, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Jan 22, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 26, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

fix(custom-element): prevent injecting child styles if shadowRoot is false #12769

Are you sure you want to change the base?

fix(custom-element): prevent injecting child styles if shadowRoot is false #12769

Uh oh!

Conversation

edison1105 commented Jan 22, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

github-actions bot commented Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Size Report

Bundles

Usages

Uh oh!

pkg-pr-new bot commented Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

edison1105 commented Jan 22, 2025 •

edited by coderabbitai bot

Loading

github-actions bot commented Jan 22, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 22, 2025 •

edited

Loading

coderabbitai bot commented May 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)